Migrate to Vue 3 - #1025

Lots of lifting in this - I'm likely the last to provide useful feedback, but I went ahead and asked an LLM to look over the PR for any low-hanging fruit feedback that might help improve this if the DocC render maintainers are so inclined.

From that output:

• OverviewCard's "head" slot looks like it was dropped.
• BreakpointEmitter.spec.js looks like the test was gutted, not actually updated.
• The LLM asserted that Accessibility linting was added, then more or less shut down/neutered. My personal take is leaning more heavily into active linting to guide feedback on the migration, so from my point view, I'd re-enable all the base linting it disabled, and consider adding more were relevant, and let the agents churn on resolving and fixing.
• vitest expect-expect and valid-expect are apparently also disabled.

I stumbled over pnpm test not passing as well, but didn't dig into that detail at any level.

(note: I am not a maintainer on this project, more a very interested consumer of it)

OverviewCard's "head" slot looks like it was dropped.

I don't see any change made to OverviewCard.
https://github.com/mchoo7/swift-docc-render/blob/vue3/src/components/ContentNode/OverviewCard.vue

BreakpointEmitter.spec.js looks like the test was gutted, not actually updated.

Updated

The LLM asserted that Accessibility linting was added, then more or less shut down/neutered. My personal take is leaning more heavily into active linting to guide feedback on the migration, so from my point view, I'd re-enable all the base linting it disabled, and consider adding more were relevant, and let the agents churn on resolving and fixing.
vitest expect-expect and valid-expect are apparently also disabled.

I was going to do ESLint (and Prettier) in a follow-up PR.

I stumbled over pnpm test not passing as well, but didn't dig into that detail at any level.

I don't see any failures. Could you share the error message please?

During unit test, 65% of time was spent on jsdom creation. We now use vmThreads pooling which reduces unit test time by 83% (30.1s to 5.1s).

I've been doing some manual testing with example documentation content before getting to thoroughly review the changed files, and things are generally looking pretty good so far.

I'm still testing, but here are a few minor issues I've noticed that we'll want to fix:

• the footer is much too big on pages with little content and looks broken (404 page is easy example of this)
• the color of the main "Documentation" link in the sidebar is now blue but should remain white (easy to miss since it is usually not linked in most archives)
• the URLs for linkable headings seem off--looks like maybe the forward slashes in the URL are getting percent encoded or something

Still testing and reviewing the changes.

Here are a couple of new issues I've noticed:

• the linked "Documentation" sidebar link is still blue instead of white (doesn't seem like your previous fix worked here)
• same issue with the "[Name] Tutorials" link in the tutorials navbar where [Name] is now blue when it shouldn't be
• the primary/secondary dropdowns in the tutorials navbar seem to be missing visual borders, and they don't work unless you click the exact text
• for the TutorialsOverview page, the spacing looks off for the left-hand-side chapter menu

I asked LLM to fix the issues for now.

However, the docs provided by this repository does not have Documentation link or any tutorial page, so I cannot verify by myself. Is there a way to obtain a good docc for testing (e.g. xcode)?

I asked LLM to fix the issues for now.

Great, I think these issues are resolved now. Thanks!

However, the docs provided by this repository does not have Documentation link or any tutorial page, so I cannot verify by myself. Is there a way to obtain a good docc for testing (e.g. xcode)?

One way is to download the "SlothCreator" sample code from here and build the archive with Xcode and/or DocC itself. You can then point DocC-Render at the built archive or directly build it with the version of DocC-Render here.

Probably the easiest way is to create an empty tutorial using docc init. Something like:

# create Example.docc with stub tutorial page
xcrun docc init --name Example --output-dir . --template tutorial

Here is some additional documentation on directly integrating a built version of this renderer with DocC itself using the DOCC_HTML_DIR var. (I haven't tested this on the branch yet but will soon)